home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / graphic / flilib.zip / FLIDOC.TXT < prev    next >
Text File  |  1990-02-20  |  45KB  |  1,334 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                 Turbo C FLI Library Documentation
  13.            For FLI Files Created by Autodesk Animator
  14.  
  15.                         November 20, 1989
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50. Copyright 1989-1990 Dancing Flame, San Francisco
  51. Program Code and Library by Jim Kent
  52. Documentation by Jim Kent and Heidi Brumbaugh
  53.  
  54.                        Turbo C FLI Library
  55.                         Table of Contents
  56.  
  57.  
  58.  
  59.  
  60.  
  61. 1. Introduction to the Turbo C FLI library. . . . . . . . . .   1
  62.  
  63. 2. Sample FLI programs. . . . . . . . . . . . . . . . . . . .   1
  64.      2.1 PLAY.C . . . . . . . . . . . . . . . . . . . . . . .   1
  65.      2.2 ALLFLIS.C. . . . . . . . . . . . . . . . . . . . . .   2
  66.      2.3 SLICEFLI.C . . . . . . . . . . . . . . . . . . . . .   3
  67.  
  68. 3. Usage of FLI routines. . . . . . . . . . . . . . . . . . .   5
  69.      3.1 Playback Routines. . . . . . . . . . . . . . . . . .   5
  70.      3.2 Save Routines. . . . . . . . . . . . . . . . . . . .   6
  71.  
  72. 4. VGA Graphics Support . . . . . . . . . . . . . . . . . . .   7
  73.  
  74. 5. MS-DOS Support . . . . . . . . . . . . . . . . . . . . . .   8
  75.  
  76. 6. The FLILIB header files. . . . . . . . . . . . . . . . . .  10
  77.      6.1 AAFLISAV.H . . . . . . . . . . . . . . . . . . . . .  10
  78.      6.2 AAFLI.H. . . . . . . . . . . . . . . . . . . . . . .  11
  79.      6.3 AATYPES.H  . . . . . . . . . . . . . . . . . . . . .  13
  80.      6.4 AADOS.H. . . . . . . . . . . . . . . . . . . . . . .  14
  81.      6.5 AAERR.H. . . . . . . . . . . . . . . . . . . . . . .  16
  82.      6.6 AASCREEN.H . . . . . . . . . . . . . . . . . . . . .  16
  83.  
  84. 8. Autodesk Animator files. . . . . . . . . . . . . . . . . .  18
  85.      8.1 Flic Files (.FLI). . . . . . . . . . . . . . . . . .  18
  86.      8.2 Picture Files (.GIF) . . . . . . . . . . . . . . . .  21
  87.      8.3 Cel Files (.CEL and .PIC). . . . . . . . . . . . . .  21
  88.      8.4 Palette Files (.COL) . . . . . . . . . . . . . . . .  22
  89.      8.5 Mask Files (.MSK). . . . . . . . . . . . . . . . . .  22
  90.      8.6 Text Files (.TXT). . . . . . . . . . . . . . . . . .  22
  91.      8.7 Font Files (.FNT). . . . . . . . . . . . . . . . . .  22
  92.      8.8 Polygon and Path files (.PLY). . . . . . . . . . . .  24
  93.      8.9 Optics Files (.OPT). . . . . . . . . . . . . . . . .  24
  94.      8.10 Record Files (.REC) . . . . . . . . . . . . . . . .  24
  95.  
  96.  
  97. 1. Introduction to the Turbo C FLI library
  98.  
  99.      FLI.LIB is a Turbo C large model library for manipulating 
  100. Autodesk Animator FLI files.  It also contains some general-
  101. purpose MS-DOS functions and a few VGA graphics primitives.
  102.  
  103.      The main Turbo C library is contained in the file FLI.LIB. 
  104. Additionally, you will need to include the header file AAFLI.H to
  105. read a FLI file and AAFLISAV.H to save a FLI file.  AAFLI.H will 
  106. include the additional files AATYPES.H, AADOS.H, AAERR.H and
  107. AASCREEN.H if they are not already included.  AAFLISAV.H will
  108. include AAFLI.H if it is not already included.
  109.  
  110.      The 58 source file routines to load or save a FLI are in the
  111. folder LIBSOURC; however, these modules are not necessary as they
  112. are already included in FLI.LIB.
  113.  
  114.      Your disk also includes three sample C files to load and
  115. play a FLI file.  The sample batch file which compiles these
  116. files in Turbo C is:
  117.  
  118. tcc -ml play.c fli.lib 
  119. tcc -ml allflis.c fli.lib 
  120. tcc -ml slicefli.c fli.lib
  121.  
  122.      In sum, the files you will need to use the Turbo C FLI
  123. library are:
  124.  
  125. AATYPES.H
  126. AADOS.H
  127. AAERR.H
  128. AASCREEN.H
  129. AAFLI.H
  130. AAFLISAV.H
  131. FLI.LIB
  132.  
  133. 2. Sample FLI programs
  134.  
  135.      Once the header files are included in your code and your
  136. make file is set up to properly link your program with the
  137. library, calling the high-level FLI routines is very
  138. straightforward.  In fact, the sample programs show that you can
  139. write a program to play back a FLI in about twenty-five lines --
  140. and most of that code is to verify that a VGA is connected!
  141.  
  142. 2.1 PLAY.C
  143.  
  144. This program will play a FLI file until a key is pressed.
  145.  
  146. #include "aafli.h" 
  147.  
  148. main(int argc, char *argv[]) 
  149. { 
  150. int ivmode; 
  151. Errval err; 
  152. if (argc != 2)   /* If command line looks wrong give a little help */
  153.  
  154.    { 
  155.    puts("Play will play a FLI file until a key is hit"); 
  156.    puts("Example usage: play pretty.fli"); 
  157.    } 
  158. else 
  159.    { 
  160.    ivmode = dos_get_vmode();  /* Get video mode to restore at exit */ 
  161.    dos_set_vmode(0x13);       /* Go into 320x200 256 color mode */ 
  162.    if (dos_get_vmode() == 0x13) 
  163.       { 
  164.       err = fli_play(argv[1]); 
  165.       dos_set_vmode(ivmode); 
  166.       if (err < AA_SUCCESS) 
  167.          puts(fli_error_message(err) ); 
  168.       } 
  169.    else 
  170.       puts("Not a VGA/MCGA display"); 
  171.    } 
  172. } 
  173.  
  174. 2.2 ALLFLIS.C
  175.  
  176. This program plays all the FLI files in the current directory
  177. once and exits.
  178.  
  179. #include "aafli.h" 
  180.  
  181. main() 
  182. { 
  183. Fndata *fn; 
  184. int ivmode; 
  185. Errval err; 
  186.  
  187. fn = dos_get_dta(); 
  188. if (dos_first("*.FLI", DOS_ATTR_NORMAL)) 
  189.    { 
  190.    ivmode = dos_get_vmode(); 
  191.    dos_set_vmode(0x13); 
  192.    if (dos_get_vmode() == 0x13) 
  193.       { 
  194.       for (;;) 
  195.          { 
  196.          if (dos_key_is()) /* check keyboard to abort between FLI's */
  197.             { 
  198.             dos_key_in(); 
  199.             break; 
  200.             } 
  201.          err = fli_once(fn->name); 
  202.          if (err < AA_SUCCESS) 
  203.             {  puts(fli_error_message(err)); 
  204.             } 
  205.          if (!dos_next()) 
  206.             break; 
  207.          } 
  208.       dos_set_vmode(ivmode); 
  209.       } 
  210.    else 
  211.       { 
  212.       puts("Not a VGA/MCGA display"); 
  213.       } 
  214.    } 
  215. else 
  216.    { 
  217.    puts("No .FLI files"); 
  218.    } 
  219. } 
  220.  
  221. 2.3 SLICEFLI.C
  222.  
  223. This program cuts out every other line of a FLI file, creating a
  224. new FLI.
  225.  
  226. #include "aaflisav.h" 
  227.  
  228. main(int argc, char *argv[]) 
  229. { 
  230. int i; 
  231. Errval err; 
  232. int ivmode; 
  233.  
  234. if (argc != 3) 
  235.    { 
  236.    puts("slicefli - a program to cut out every other line of a FLI.");
  237.    puts("   usage:  slicefli infile.fli outfile.fli"); 
  238.    exit(0); 
  239.    } 
  240. ivmode = dos_get_vmode(); 
  241. dos_set_vmode(0x13); /* To VGA/MCGA 320x200 256 color mode */ 
  242. if (dos_get_vmode() != 0x13) 
  243.    { 
  244.    puts("Not a VGA/MCGA display, sorry"); 
  245.    } 
  246. else 
  247.    { 
  248.    err = convert_fli(argv[1], argv[2]); 
  249.    if (err >= AA_SUCCESS) 
  250.       { 
  251.       fli_play(argv[2]); 
  252.       } 
  253.    dos_set_vmode(ivmode); 
  254.    if (err < AA_SUCCESS) puts(fli_error_message(err)); 
  255.    } 
  256. } 
  257.  
  258. /* zero out every other line of a screen */ 
  259. void slice_screen(Vscreen *s) 
  260. { 
  261. int i; 
  262. Pixel *p; 
  263.  
  264. p = s->p; 
  265. for (i=0; i<s->h; i+=2) 
  266.    { 
  267.    i86_bzero(p, s->bpr); 
  268.    p += 2*s->bpr; 
  269.    } 
  270. } 
  271.  
  272. Errval convert_fli(char *in, char *out) 
  273. { 
  274. Errval err = AA_SUCCESS;   /* start out optimistic! */ 
  275. Vscreen *bs; 
  276. Fli_head inhead, outhead; 
  277. Jfile infile = 0, outfile = 0; 
  278. int i; 
  279.  
  280. if ((bs = aa_alloc_mem_screen()) == NULL) 
  281.    { 
  282.    err = AA_ERR_NOMEM; 
  283.    goto EXIT; 
  284.    } 
  285. if ((infile = fli_open(in, &inhead)) < 0) 
  286.    { 
  287.    err = infile; 
  288.    goto EXIT; 
  289.    } 
  290. if ((outfile = fli_create(out, &outhead, inhead.speed)) < AA_SUCCESS) 
  291.    { 
  292.    goto EXIT; 
  293.    } 
  294. for (i=0; i<inhead.frame_count; i++) 
  295.    { 
  296.    aa_copy_screen(&aa_screen, bs); 
  297.    if ((err = fli_next_frame(infile)) < AA_SUCCESS) 
  298.       { 
  299.       goto EXIT; 
  300.       } 
  301.    slice_screen(&aa_screen); 
  302.    if ((err = fli_write_next(outfile, &outhead, &aa_screen, bs)) <
  303. AA_SUCCESS) 
  304.       { 
  305.       goto EXIT;  } 
  306.    } 
  307. if ((err = fli_end(outfile, &outhead, &aa_screen, bs)) < AA_SUCCESS) 
  308.    { 
  309.    goto EXIT; 
  310.    } 
  311. EXIT: 
  312. if (infile != 0) 
  313.    dos_close (infile); 
  314. if (outfile != 0) 
  315.    dos_close (outfile); 
  316. aa_free_mem_screen(bs); 
  317. if (err < AA_SUCCESS) 
  318.    { 
  319.    dos_delete (out); 
  320.    } 
  321. return(err); 
  322. } 
  323.  
  324. 3. Usage of FLI routines
  325.  
  326. 3.1 Playback Routines
  327.  
  328.      These are the main routines you will need to use to play
  329. back a FLI animation.  Note that you do not need to call some of
  330. the routines directly if you use only the high-level routines. 
  331. See the sample programs above for details.
  332.  
  333. Play a FLI on VGA screen until a key is hit. 
  334.    Errval fli_play(char *fliname) 
  335.  
  336. Play a FLI through once on VGA screen. 
  337.    Errval fli_once(char *fliname) 
  338.  
  339. Open up a FLI file,